home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 007 / sub33a.arc / SUB.DOC < prev    next >
Encoding:
Text File  |  1987-08-14  |  14.2 KB  |  319 lines
  1.  
  2. Sub v3.3a (c) Jean Lalonde, Montreal, CANADA, August 1987
  3. =========================================================
  4.  
  5.  
  6.      Table of content
  7.      ----------------
  8.  
  9.      1 - Distribution
  10.  
  11.      2 - Sub's features summary
  12.  
  13.      3 - Using Sub v3.3
  14.  
  15.          3a- Sub's commands
  16.  
  17.          3b- Sub's display
  18.  
  19.          3b- Sub's syntax
  20.  
  21.  
  22.  
  23. 1 - Distribution
  24. ================
  25.  
  26.      This program can be distributed if it is done without profit.
  27. Individuals can use Sub freely.  Non-individuals users, please, send me $20
  28. per copy used. Sources are available for $25.  Buying the sources gives you
  29. the right to modify the program as you wish.  Please, send comments, bug
  30. reports, registrations or sources order (with check or money order to Jean
  31. Lalonde) at the following address:
  32.  
  33.                               Jean Lalonde
  34.                               P.O. BOX 721
  35.                               Station "R"
  36.                               Montreal
  37.                               CANADA
  38.                               H2S-3M4
  39.  
  40.      You can join me online on Compuserve (ID: 76606,671) or on BIX Info
  41. Exchange (Bix name: jlalonde).  Sub is written in  MODULA-2/86, Rel. 2.0
  42. (A), PC/MS-DOS 8088/8086, LOGITECH, (C) Copyright 1983, 1984, 1985, 1986.
  43. Sub uses standard PC/MS-DOS functions, it support redirected input/output.
  44. Clones having problem with Ctr-C or Ctr-Break should use /q option to enable
  45. <escape> and disable Break (note that the option /q will disable the type
  46. ahead buffer).
  47.  
  48.  
  49.  
  50. 2 - Sub's v3.3 features summary
  51. ===============================
  52.  
  53.       Main improvement in version 3.3:
  54.       - An exclusion list is allowed in the files spec.  The exclusion
  55.          list follows a '/' in the filenames list.
  56.       - The DOS function "Jump" to exit Sub to the directory currently 
  57.          scanned by Sub.
  58.  
  59.       Since version 3.2:
  60.       - Search for given files on hardisk
  61.       - Accept multiple drives and multiple files search request
  62.       - DOS functions to apply to found files: from menu or with copy,
  63.          delete, move, rename, type or change attributes switches
  64.       - scan top directory only or down from a given directory
  65.          (including children)
  66.       - tell you where it is searching
  67.       - search abortable with Ctr-C, Ctr-Break or <escape>
  68.       - search abortable *anytime*
  69.       - default values (current drive, directory and *.*)
  70.       - search according to files date or size
  71.       - search according to files attributes
  72.       - give you total bytes of files found
  73.       - give the files found count
  74.       - can show you only the final result
  75.       - optional display of space free on disk
  76.       - choice of brief or complete display
  77.       - page break and customizable page length
  78.       - MS/PC-DOS compatible (3.0 and later)
  79.       - allow Input/Output redirection (to printer, files or modem)
  80.       - help within the program
  81.  
  82.  
  83.  
  84. 3 - Using Sub v3.3
  85. ==================
  86.  
  87. 3a - Sub's commands
  88. -------------------
  89.  
  90.      You can specify almost every Sub's commands at the DOS line.  If Sub
  91. is called without parameter, it will show you all files of the current
  92. directory and of its children with the default display options.  To narrow
  93. the action to a given section of your hard-disk, you must specify the
  94. "parent directory".  Then, Sub will work on this directory and on its
  95. children directories.  To apply the action of Sub to the whole hard-disk,
  96. specify "Sub \" (backslash "\" meaning root directory).   You can also
  97. restrict Sub to the given top directory (see option /t).
  98.  
  99.      If you do not specify a drive, Sub will work on the current drive.  If
  100. you want to work on another drive, specify wich drive in your DOS command
  101. "Sub a:dir\files".  You can work on multiple drives.  To scan every sub-
  102. directories on your hard-disk c: and d:, enter "Sub cd:\".  
  103.  
  104.      If you want Sub to find only files matching a given pattern (such as
  105. "*.BAT"), you must specify it right after the parent directory, separating
  106. the directory and the filename by a backslash ("\"). To look for batch
  107. files down from the \DOS directory, specify "Sub \DOS\*.BAT".  You can
  108. enter multiple filenames.  For example, if you want a list of your
  109. executable files, enter the command "Sub *.BAT+*.COM+*.EXE".  You can also
  110. specify an exclusion list after a '/'.  For example, for every files except
  111. executable files, enter "Sub *.*/*.BAT+*.COM+*.EXE".
  112.  
  113.      If you do not specify files after the last "\" of the sub-directory,
  114. Sub will scan all files ("*.*") down from this directory.  For example,
  115. "Sub  \thisdir\" is understood as "Sub \thisdir\*.*".
  116.  
  117.      You can apply other filters to the Sub's search, selecting according
  118. to attributes (see option /a), dates or size (options /: /+ or /-).
  119.  
  120.      Sub can also call DOS functions (option /d) and apply them to the files
  121. found.  You can copy those files (/d:c), delete them (/d:d), move/redirect
  122. them (/d:m), remane them (/d:r), type them (/d:t) or change their
  123. attributes (/d:a).  For each function, Sub will ask you for additionnal
  124. information if needed.  You can also "jump" to a new directory when exiting
  125. Sub (with the DOS function /d:j). 
  126.  
  127.      Sub offers you an expert swith for DOS commands.  With /x, your
  128. command will be executed without *any* confirmation prompt.  Use this
  129. option at your own risk and be careful!
  130.  
  131.      You can also use DOS commands from a menu.  Specify only /d without
  132. DOS function and Sub will prompt you with a functions menu for each file
  133. found.  In this case, Sub will not ask for confirmation before applying
  134. a DOS function.
  135.  
  136.      Permanent parameters can be specified in your environment.  Your
  137. AUTOEXEC.BAT should specify: 'SET SUBSPEC=/x/x...' (eg.: SET SUBSPEC=/c/f).
  138.  
  139.  
  140. 3b - Sub's display
  141. ------------------
  142.  
  143.      Correct screen output requires ANSI.SYS to be specified in your
  144. CONFIG.SYS file (DEVICE=ANSI.SYS).  If you use Sub via modem, your
  145. communication program must emulate VT-100 or ANSI protocols.
  146.  
  147.      Sub has two display modes.  In "brief mode" (option /b) it will only
  148. show you the path and file name. In "normal mode", it will show you:
  149.  
  150. files count    time     size   drive                 filename
  151.          date            attributes       path
  152.  
  153.    1:  87aug08 17:57   14245 a  C:\M2LIB\DEV\SUB\EXP\SUB.DOC
  154.  
  155.      Some display features are customizable.  You can ask Sub to display
  156. only its report (option /r), show the free space on the given drive (option
  157. /f).  You can change the number of "lines per page" for your monitor
  158. (option /p) and specify if you do not want page break (option /c).  You can
  159. force line feed (option /l) if you redirect the output to the printer or a
  160. file.  Sub will show you the current directory it is scanning.  If you do
  161. not like, you can suppress this information (option /s).
  162.  
  163.      When page break is ON, Sub will display "<space>, N(on stop or <Esc> "
  164. at every 24 lines (or else if specified with option /p).  Press <space> to
  165. see the next page, 'N' to display the other files non-stop or <escape> to
  166. abort.
  167.  
  168.      If you use Sub remotely (for example, through a modem), it can be
  169. impossible to send the <escape> key.  In this case, everywhere <escape>
  170. should be used, send Ctrl-X or Ctrl-C.
  171.  
  172.  
  173. 3c - Sub's syntax
  174. -----------------
  175.  
  176. C>Sub drives:\subdirectory\filenames /options
  177.  
  178.    drives:      - Drives to scan (default= current drive).
  179.    subDirectory - Top level to scan from (default= current directory).
  180.                   Maximal length for 'subDirectory' is 64 chars.
  181.    fileName     - File to search for or files to list, wild cards * and ? are
  182.                   allowed (default= all files *.*), multiple file names are
  183.                   allowed seperated by '+' ('*.COM+*.EXE+...'), exclusion list
  184.                   after '/'.  Maximal length for 'fileName' is 128 chars.
  185.  
  186.  
  187.  
  188.    Options:
  189.  
  190.       /: /+ /-  list files with date/size selection, default is no selection.
  191.         syntax= Date: 'YYmmmDD', 'mmmDD', 'today', eg: 87apr22, 87jan, today.
  192.                 Size: 'xxxK', eg: 100k.
  193.                 /:DateSize (files of <this> date or <this> size),
  194.                 /:DateSize+n (files of <this> date/size plus n days/kb),
  195.                 /:DateSize-n (files of <this> date/size minus n days/kb),
  196.                 /+DateSize (files <from>...) or
  197.                 /-DateSize (<up to>...).
  198.  
  199.  
  200.            You can enter a range of dates or sizes by adding +n or -n at
  201.            the end of the date or size, where n is the number of days or
  202.            kilo-bytes before or after the given date or size.  More than
  203.            one date or size criteria may be specified to list files
  204.            from...to given dates or given size.
  205.  
  206.            Date format is year (two numbers), month (three letters) and day
  207.            (two numbers) with no space (e.g.: "87jan14"). If you only type
  208.            the year, default month and day are January first (e.g.: "85"
  209.            means "85jan1").  If you only specify month, current year and
  210.            first of the month are considered (e.g.: this year, "jan" means
  211.            "87jan01").  If you type mmmDD, the year is the current one
  212.            (e.g.: "jan23" means "87jan23"). The date "today" gives you the
  213.            current system date.  If no date selection is specified, files
  214.            of any date are listed.
  215.  
  216.            Size format is a number from 0 to 1000000000 (1,000 megs!) and
  217.            the letter "k" (e.g.: 1k or 1234k).  Sub will return you the
  218.            files with the given size and 1,023 bytes *less* (e.g.: the size
  219.            1k will gives you files from 1 byte to 1,024 bytes).
  220.  
  221.  
  222.       /A to specify file's Attributes, syntax is /a:attributes.
  223.  
  224.            Attributes are:
  225.               R= Read Only     H= Hidden        S= System
  226.               V= Volume        D= Directory     A= Archive
  227.               N= No Attribute  ALL= any atributes
  228.  
  229.            Default is /a:ran (Read Only, Archive or No attribute).
  230.            To find files with more than one attribute, all attributes must
  231.            be specified (e.g. system files have attributes /a:rhs).
  232.  
  233.       /B for Brief display (only d:\dir\filename), syntax= /b, default is OFF
  234.          (number, date, time, size, attribute, drive, directory and file name).
  235.  
  236.       /C for Continuous display, disable page break, default is OFF (see /P).
  237.  
  238.       /D to call DOS commands Copy, Delete, Move, Rename, Type, Change 
  239.          attribute or Jump, syntax=
  240.  
  241.          /d to call a menu for each file found.  After the commands copy
  242.            and type, the menu will reappear for the same file.  This way,
  243.            you could type a file before deleting it.  Other commands will
  244.            cause Sub to search for the next file.
  245.  
  246.          /d:c to copy file(s): You have to specify in your command the
  247.                                directory where to copy files (e.g.:
  248.                                "Sub \*.arc /d:c \allarc").  Sub will ask
  249.                                you to confirm your request and if you want
  250.                                to confirm for each file.
  251.  
  252.          /d:d to delete file(s): Sub will ask you to confirm your request
  253.                                  and if you want to confirm each deletion.
  254.  
  255.          /d:m to move file(s): You have to specify in your command the
  256.                                directory where to move files (e.g.:
  257.                                "Sub \*.arc /d:m \allarc").  Sub will ask
  258.                                you to confirm your request and if you want
  259.                                to confirm for each file.
  260.  
  261.          /d:r to rename file(s): You have to specify in your command the
  262.                                  new name (e.g.: "Sub toto.* /d:r coco.*").
  263.                                  Sub will ask you if you want to confirm
  264.                                  for each file.
  265.  
  266.          /d:t to type file(s): Sub will ask you to confirm your request and if 
  267.                                you want to confirm for each file.
  268.  
  269.          /d:a to change an attribute to file(s): You have to specify in
  270.                                  your command the attribute to change with
  271.                                  syntax: +X or -X to set or remove the
  272.                                  attribute X (e.g.: "Sub *.* /d:a -A").
  273.                                  See attributes list in option /A.  Sub
  274.                                  will ask you if you want to confirm for
  275.                                  each file.
  276.  
  277.          /d:j to jump to a new directory when exiting Sub: Sub will ask you to 
  278.                                  confirm your request and if you want to 
  279.                                  confirm for which directory or jump to the
  280.                                  first found.
  281.  
  282.                                  NOTE: In the current version, if the directory
  283.                                  to "jump" is on a drive other than the 
  284.                                  original drive, Sub will change the directory
  285.                                  on this drive *but* the exiting drive will 
  286.                                  remain the original one.  All you will have
  287.                                  to do after Sub is changing the drive yourself
  288.                                  and you will be in the new directory.  I will
  289.                                  have to path my run-time system to fix it...
  290.  
  291.  
  292.       /F to report Free space, default is OFF.
  293.  
  294.       /H display Help file.  SUB.HLP must be in the current directory or in
  295.          one of your path directories (PATH=\DIR).
  296.  
  297.       /L to force Linefeed while scanning, default is OFF.
  298.  
  299.       /P specify Page length (Sub stop the display at every x lines), syntax=
  300.          /p:x (with x from 1 to 65535), default is 24 lines (see option /C).
  301.  
  302.       /Q to Quit (abort) with <escape> instead of Ctr-C, default is OFF.
  303.  
  304.       /R to display only the Report (number of files found and total size),
  305.          default is OFF.
  306.  
  307.       /S for Silent scan (does not display the names of currently scanned
  308.          directory), default is OFF.
  309.  
  310.       /T to scan only the Top level (parent) directory, default is OFF (scan
  311.          from parent directory to lowest levels).
  312.  
  313.       /X to avoid *any* confirmation prompt relative to DOS commands (/d:).
  314.          *** WARNING: the use of this feature is at your own risk. ***
  315.  
  316.  
  317.  
  318. -eof-
  319.